/*-
 * #%L
 * HAPI FHIR - Master Data Management
 * %%
 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.fhir.mdm.svc;

import ca.uhn.fhir.interceptor.model.RequestPartitionId;
import ca.uhn.fhir.jpa.model.dao.JpaPid;
import org.hl7.fhir.instance.model.api.IBaseResource;

import java.util.Set;

/**
 * Interface for mdm expanding Group resources on group bulk export
 */
public interface IBulkExportMdmResourceExpander {

	/**
	 * For the Group resource with the given id, returns all the persistent id ofs
	 * the members of the group + the mdm matched resources to a member in the group
	 */
	Set<JpaPid> expandGroup(String groupResourceId, RequestPartitionId requestPartitionId);

	/**
	 * annotates the given resource to be exported with the implementation specific extra information if applicable
	 */
	void annotateResource(IBaseResource resource);
}
